Matter Switch: Add StatelessStep capability support for SwitchLevel and ColorTemperature#2677
Matter Switch: Add StatelessStep capability support for SwitchLevel and ColorTemperature#2677hcarter-775 merged 1 commit intomainfrom
Conversation
|
Duplicate profile check: Warning - duplicate profiles detected. |
|
Channel deleted. |
Test Results 72 files 486 suites 0s ⏱️ Results for commit 6863a78. ♻️ This comment has been updated with latest results. |
|
Minimum allowed coverage is Generated by 🐒 cobertura-action against 6863a78 |
drivers/SmartThings/matter-switch/src/switch_handlers/capability_handlers.lua
Outdated
Show resolved
Hide resolved
drivers/SmartThings/matter-switch/src/switch_handlers/capability_handlers.lua
Outdated
Show resolved
Hide resolved
drivers/SmartThings/matter-switch/capabilities/statelessColorTemperatureStep.yml
Outdated
Show resolved
Hide resolved
drivers/SmartThings/matter-switch/src/switch_handlers/capability_handlers.lua
Outdated
Show resolved
Hide resolved
drivers/SmartThings/matter-switch/src/switch_handlers/capability_handlers.lua
Outdated
Show resolved
Hide resolved
80a5c0a to
00f1bf4
Compare
nickolas-deboom
left a comment
There was a problem hiding this comment.
I approved earlier but noticed there are some print statements from debugging I assume
|
@nickolas-deboom thanks for the catch, got those removed |
nickolas-deboom
left a comment
There was a problem hiding this comment.
LGTM! Looks like there is are test failures but I ran the tests locally and they pass, so they might need to be re-run in CI
drivers/SmartThings/matter-switch/profiles/light-color-level.yml
Outdated
Show resolved
Hide resolved
drivers/SmartThings/matter-switch/src/test/test_stateless_step.lua
Outdated
Show resolved
Hide resolved
drivers/SmartThings/matter-switch/src/switch_handlers/capability_handlers.lua
Outdated
Show resolved
Hide resolved
drivers/SmartThings/matter-switch/src/switch_handlers/capability_handlers.lua
Show resolved
Hide resolved
drivers/SmartThings/matter-switch/src/switch_handlers/capability_handlers.lua
Show resolved
Hide resolved
| local endpoint_id = device:component_to_endpoint(cmd.component) | ||
| local step_mode = step_size > 0 and clusters.LevelControl.types.StepMode.UP or clusters.LevelControl.types.StepMode.DOWN | ||
| print("level:", step_size) | ||
| device:send(clusters.LevelControl.server.commands.Step(device, endpoint_id, step_mode, math.abs(step_size), fields.TRANSITION_TIME, fields.OPTIONS_MASK, fields.OPTIONS_OVERRIDE)) |
There was a problem hiding this comment.
@tpmanley @hcarter-775 What about using StepWithOnOff to turn on the light while it's off state?
Do we plan to support the level change during the 'off' state?
and Does transition(0) is best choice for the smooth transition? I wonder this is the best value from the test with real devices.
Now, all have '0' value.
lua_libs\st\matter\defaults\colorControl.lua
local TRANSITION_TIME = 0 --1/10ths of a second
lua_libs\st\matter\defaults\colorTemperature.lua
local TRANSITION_TIME = 0 --1/10ths of a second
There was a problem hiding this comment.
It really depends on the scenario, using the normal Step and a transition time of 0 is the most sensible default.
I have been playing with all those parameters for months with my custom driver for Matter lights and multiple buttons (including the new BILRESA scroll) so I will share the experience in case it is useful.
StepWithOnOff is great for dimmers that do not have on/off dedicated buttons since otherwise you would have no way to control the on/off state. It has two main drawbacks though:
- Cannot set the lights to the minimum brightness level. Most of the time you end up with the light turned off because it's virtually impossible to stop at the minimum. Or just impossible if the minimum is 1% and the steps are, let's say, 10%, it will go from 10% to off with the final step.
- If you are controlling multiple lights at the same time, they will all turn on or off. As a user, most of the time I do not want that behaviour and expect to control the brightness of the lights that are on, not turn on everything.
Transition time is a great feature of Matter that should have more presence in the capabilities. setLevel of switchLevel has it but not the commands to set colours or colour temperature. It is something requested time ago and the main reason for me to use a custom driver.
When it comes to stepping the brightness level, using transitions is tricky:
- Some lights flood the hub with brightness level reports while stepping, especially before Matter 1.4 made quiet reporting mandatory. That makes the hub sluggish for a moment and the user would feel the dimming is not responsive. With some lights a transition time of 1 (tenth of a second) the experience is fine, with others it's better to leave it at 0 since they already apply some default transition anyway.
- If two step commands are sent too close in time and the first one did not end the transition yet, the first step is essentially killed. That's easy to experience with a BILRESA scroll since the steps can happen too fast as you scroll.
For added flexibility, the capability should have optional second and third command arguments for the transition time and the withOnOff behaviour. That would make the default 0 and normal Step if not provided. Maybe it is not late to add them being a proposed capability not yet used elsewhere.
While unrelated to the steps, adding the transition time argument to the commands to set colour and temperature would be great too, like in setLevel of switchLevel capability. It should not break anything since the default is 0 anyway.
There was a problem hiding this comment.
@hcarter-775 Thank you for your detailed explanation.
It could be linked to the below conversion, so we need decide more beneficial UX for the user.
- 'turning on' before changing the level
- keep 'off' state and just change level silently.
- doing nothing while 'off' state.
and Regarding the 'transition time', what about adding the preference setting in edge driver for this?
We can't expect same result for different models, so we can give an option to the user. (default:'0')
Definitely, we need to support multi-language for the new setting menu.
cc: @tpmanley
There was a problem hiding this comment.
@hcarter-775 Thank you for your detailed explanation
That was my comment actually, I hope I didn't create any confusion! I'm the developer of the Matter Playground custom driver and thought it was useful to share my feedback.
There was a problem hiding this comment.
@mocelet Oh, sorry my mistake. Thank you for sharing your thought and experience.
There was a problem hiding this comment.
@inasail, after some internal discussion, I have updated the implementation to ignore step updates if the device is turned off, but without turning the device "on" if it is off, or vice versa. This decision was made in part from the idea that multiple lights may be connected to the knob, though brightening some should not necessarily turn them all on, if they were previously off. However, in this same vein, I also do not think the off devices should be affected while they are off.
Let me know if you disagree with this implementation.
Also, since this conversation is very similar to the one below, I am going to resolve that conversation for the moment. Feel free to re-open as needed.
There was a problem hiding this comment.
@hcarter-775 The downside of the Step not executing when the light is off is that the brightness used to turn on cannot be changed and that would lead to undesired "flashes" of the last brightness.
Let's say you last used a light at 100% brightness during the afternoon. But at night you want it at a low brightness. If you can't change the brightness while it is off, it will turn on at 100% which may not be pleasing. If the brightness could be changed before switching on you would be able to lower the brightness, then turn it on and avoid the 100% brightness "flash".
drivers/SmartThings/matter-switch/src/switch_handlers/capability_handlers.lua
Outdated
Show resolved
Hide resolved
23eecf0 to
9b7146c
Compare
| SwitchFields.OPTIONS_MASK = 0x01 | ||
| SwitchFields.OPTIONS_OVERRIDE = 0x01 | ||
| -- the OptionsOverride field's first bit overrides the ExecuteIfOff option, defining whether the command should take effect when the device is off. | ||
| SwitchFields.HANDLE_COMMAND_IF_OFF = 0x01 |
There was a problem hiding this comment.
I like this, easier to understand
85cae05 to
6863a78
Compare
Description of Change
Update all profiles to support statelessStep capabilities as needed. Include handlers for these step capabilities using the Matter-provided step commands.
This breaks apart the work found in #2669 so that the stateless capability support can be reviewed as an isolated unit.
Summary of Completed Tests
Unit tests added. Tested on-device.